home *** CD-ROM | disk | FTP | other *** search
/ TPUG - Toronto PET Users Group / TPUG Users Group CD / TPUG Users Group CD.iso / AMIGA / (A)TC / (A)TCA.ADF / hlplusdemo / Documentation / cmd-ref.doc < prev    next >
Text File  |  1992-07-04  |  39KB  |  1,486 lines
  1. HAMLAB PLUS 2.0.6
  2. AREXX / CONFIG FILE COMMAND REFERENCE
  3.  
  4. (c) Copyright 1992 J. E. Hanway.  All rights reserved.
  5.  
  6. IN THIS DOCUMENT:
  7.  
  8. BACKGROUND
  9.  
  10. AREXX SYNTAX
  11.  
  12. CONFIG FILE SYNTAX
  13.  
  14. COMMAND LIST
  15.  
  16. COMMAND DESCRIPTIONS
  17.  
  18. HAMLAB PLUS ATTRIBUTES
  19.  
  20. BACKGROUND
  21.  
  22. HAMLAB PLUS uses the standard AmigaDOS command syntax for both AREXX
  23. commands and config file commands.
  24.  
  25. A good description of AmigaDOS command conventions can be found in
  26. Chapter 8 of "Using the System Software," the AmigaOS Release 2 User's
  27. manual.
  28.  
  29. All commands are valid in AREXX programs.  A subset are also valid in
  30. config files.  Those are noted by one or more of the following special
  31. symbols after the command name:
  32.  
  33.   * means that the command is valid in a config file
  34.   S means the command will be included in a file generated by the
  35.     "Save Config" operation
  36.   A means the command will be included in a file generated by the
  37.     "Save All" operation
  38.  
  39. All commands and keywords are insensitive to upper/lower case.
  40.  
  41. String arguments should be enclosed in double quotes and may include
  42. spaces and the following escape sequences:
  43.  
  44.         \n      new line
  45.         \r      carriage return
  46.         \t      horizontal tab
  47.         \a      bell
  48.         \\      backslash
  49.         \nnn    nnn is three octal digits representing the character
  50.                 code
  51.  
  52.  
  53. AREXX SYNTAX
  54.  
  55. In order to pass a command to HAMLAB PLUS from an AREXX program, it
  56. must be distinguished from a built-in AREXX command, usually by
  57. enclosing it in single quotes to make it a string.  For example, to
  58. display the message "Hello, world!" in an AREXX program, the actual
  59. line in the program could look like:
  60.  
  61. 'MESSAGE "Hello, world!"'
  62.  
  63. The external single quotes are interpreted by AREXX, and the internal
  64. double quotes are processed by HAMLAB PLUS.  Of course, it is probably
  65. more typical to build complex commands using AREXX's string operators.
  66. For example:
  67.  
  68. 'MESSAGE' '"Current value of foo,bar is' foo||','||bar '"'
  69.  
  70. CONFIG FILE SYNTAX
  71.  
  72. Although config files share some of the same commands as AREXX
  73. programs, they are NOT AREXX programs.  Although this means that you
  74. can't use AREXX program statements and variables in your config files,
  75. it does mean that config files will work on all systems, whether AREXX
  76. is present or not.
  77.  
  78. Commands in config files should not be enclosed in extra quotes like
  79. AREXX programs.
  80.  
  81. Comment lines may be included in config files by starting the line
  82. with a '#' character.
  83.  
  84. Note that HamLab 1.x config files cannot be used by HAMLAB PLUS.
  85.  
  86. COMMAND LIST
  87.  
  88. ASKFIRST        *A
  89. BEEP            *A
  90. BITPLANES       *SA
  91. CACHE12BIT      *A
  92. CACHE24BIT      *A
  93. CLEAR
  94. CLEARCONFIG     *A
  95. CLOSE
  96. CURVE           *
  97. CURVEPOINT      *
  98. DISPLAY
  99. DITHER          *SA
  100. DITHER2         *SA
  101. EXPORT
  102. FILTERPATH      *A
  103. FIXHAM          *A
  104. GAMMA           *SA
  105. GETATTR
  106. INPUTCROP       *S
  107. LOADCONFIG      *
  108. LOADCURVES      *A
  109. LOADPALETTE     *A
  110. LOCKBACKGROUND  *SA
  111. LOCKGUI
  112. MESSAGE         *
  113. MODULE          *A
  114. NOP             *
  115. ONESTEP         *SA
  116. OPEN
  117. OUTPUTCROP      *S
  118. PALETTEMODE     *SA
  119. PAN
  120. PIPEDEV         *A
  121. QUIT
  122. REQUESTFILE
  123. REQUESTNOTIFY
  124. REQUESTNUMBER
  125. REQUESTRESPONSE
  126. REQUESTSTRING
  127. RESOLUTION      *SA
  128. REVERT
  129. REXXCONSOLE     *A
  130. SAVE
  131. SAVEAS
  132. SAVECONFIG
  133. SAVECURVES
  134. SAVEMODE        *SA
  135. SAVEPALETTE
  136. SCALE           *SA
  137. SETCURVE        *SA
  138. SETREQ          *A
  139. TEMPPATH        *A
  140. UNLOCKGUI
  141. WINDOW          *A
  142.  
  143. ASKFIRST        *A
  144.  
  145. Format:   ASKFIRST [ON=TRUE=YES | OFF=FALSE=NO]
  146.  
  147. Template: ON=TRUE=YES/S,OFF=FALSE=NO/S
  148.  
  149. Purpose:  Turns "are you sure" requesters on or off.
  150.  
  151. Description:
  152.  
  153. This command controls whether requesters are displayed whenever an
  154. open or clear operation will cause unsaved work to be lost.
  155.  
  156. Example:
  157.         ASKFIRST NO
  158.  
  159.  
  160. BEEP            *A
  161.  
  162. Format:   BEEP [ON=TRUE=YES | OFF=FALSE=NO]
  163.  
  164. Template: ON=TRUE=YES/S,OFF=FALSE=NO/S
  165.  
  166. Purpose:  Turns beeping on or off.
  167.  
  168. Description:
  169.  
  170. This command controls the "Beep after long functions" setting, which
  171. causes a beep and screen flash after any display, save, or export
  172. function.
  173.  
  174. Example:
  175.         BEEP YES
  176.  
  177.  
  178. BITPLANES       *SA
  179.  
  180. Format:   BITPLANES [1 | 2 | 3 | 4 | 5 | HALFBRITE | HAM]
  181.  
  182. Template: 1/S,2/S,3/S,4/S,5/S,HALFBRITE/S,HAM/S
  183.  
  184. Purpose:  Sets the number and type of bitplanes for the output.
  185.  
  186. Description:
  187.  
  188. This command sets the number of bitplanes to display and save.  Normal
  189. modes allow 1-5 bit planes (1-4 in hires).  In addition, the special
  190. HAM and HALFBRITE keywords (available only in lores) select those
  191. special 6 bit plane modes.
  192.  
  193. Examples:
  194.         BITPLANES 4             [4 bit planes]
  195.         BITPLANES HAM           [HAM mode (implies 6 bit planes)]
  196.  
  197.  
  198. CACHE12BIT      *A
  199.  
  200. Format:   CACHE12BIT [MEM <memsize>] [DISK <disksize>]
  201.  
  202. Template: MEM/N/K,DISK/N/K
  203.  
  204. Purpose:  Sets the size(s) of the 12 bit caches.
  205.  
  206. Description:
  207.  
  208. This command sets the maximum memory and/or disk size of the 12-bit
  209. cache.  The sizes are specified in bytes.  You may use "-1" to
  210. indicate a very large cache.  (This is quite useful for a RAM cache
  211. since it tells HAMLAB PLUS to use as much RAM as necessary.  If that
  212. much RAM is not available, HL+ will automatically switch to a disk
  213. cache, if enabled.)  Specifying a zero will disable either a ram or
  214. disk cache.
  215.  
  216. For the 12-bit cache, 2 bytes are required for each pixel.
  217.  
  218. If the cache is already in use, the new settings will not take effect
  219. until other changes require the cache to be discarded.
  220.  
  221. Example:
  222.         CACHE12BIT MEM -1 DISK 0        [max memory cache, no disk]
  223.  
  224.  
  225. CACHE24BIT      *A
  226.  
  227. Format:   CACHE24BIT [MEM <memsize>] [DISK <disksize>]
  228.  
  229. Template: MEM/N/K,DISK/N/K
  230.  
  231. Purpose:  Sets the size(s) of the 24 bit caches.
  232.  
  233. Description:
  234.  
  235. This command sets the maximum memory and/or disk size of the 24-bit
  236. cache.  The sizes are specified in bytes.  You may use "-1" to
  237. indicate a very large cache.  (This is quite useful for a RAM cache
  238. since it tells HAMLAB PLUS to use as much RAM as necessary.  If that
  239. much RAM is not available, HL+ will automatically switch to a disk
  240. cache, if enabled.)  Specifying a zero will disable either a ram or
  241. disk cache.
  242.  
  243. For the 24-bit cache, 3 bytes are required for each pixel.
  244.  
  245. If the cache is already in use, the new settings will not take effect
  246. until other changes require the cache to be discarded.
  247.  
  248. Example:
  249.         CACHE24BIT MEM -1 DISK 10000000    [max mem cache, 10 megs disk]
  250.  
  251.  
  252. CLEAR
  253.  
  254. Format:   CLEAR [FORCE]
  255.  
  256. Template: FORCE/S
  257.  
  258. Purpose:  Clears the current image and all related memory and disk
  259. caches.
  260.  
  261. Description:
  262.  
  263. Unloads the current image from memory, and frees any temporary memory
  264. or disk space used by the image.
  265.  
  266. The FORCE keyword suppresses the confirmation requester.
  267.  
  268. Examples:
  269.         CLEAR                           [displays requester]
  270.         CLEAR FORCE                     [no requester]
  271.  
  272.  
  273. CLEARCONFIG     *A
  274.  
  275. Format:   CLEARCONFIG
  276.  
  277. Template: ,
  278.  
  279. Purpose:  Clears the lists of known input filter and exporter modules.
  280.  
  281. Description:
  282.  
  283. This command is used to clear out the list of know input filter and
  284. exporter modules so that a new set can be loaded.  The "Save All"
  285. command saves a CLEARCONFIG command at the beginning of a config file.
  286.  
  287. Example:
  288.         CLEARCONFIG
  289.  
  290.  
  291. CLOSE
  292.  
  293. Format:   CLOSE [FORCE]
  294.  
  295. Template:
  296.  
  297. Purpose:  Clears the current image and all related memory and disk
  298. caches.
  299.  
  300. Description:
  301.  
  302. CLOSE and CLEAR perform exactly the same function.
  303.  
  304. Examples:
  305.         CLOSE                           [displays requester]
  306.         CLOSE FORCE                     [no requester]
  307.  
  308.  
  309. CURVE           *
  310.  
  311. Format:   CURVE [CONTRAST <delta>] [BRIGHTNESS <delta>] [MONOTONIC]
  312.           [SMOOTH] [NEGATE] [INIT] [UPDATE]
  313.  
  314. Template: CONTRAST/N/K,BRIGHTNESS/N/K,MONOTONIC/S,SMOOTH/S,NEGATE/S,
  315.           INIT/S,UPDATE/S
  316.  
  317. Purpose:  Applies operations to the active color response curves.
  318.  
  319. Description:
  320.  
  321. This command performs one of several modification functions on the
  322. active color response curves.
  323.  
  324. BRIGHTNESS and DELTA correspond to the similar user interface
  325. functions.  Both take a signed numeric argument which corresponds to
  326. the step size to be used.
  327.  
  328. MONOTONIC, SMOOTH, NEGATE, and INIT all correspond to user interface
  329. functions.
  330.  
  331. UPDATE causes the visual display of the curve to be updated.  This is
  332. not necessary after any of the other functions in this command, but is
  333. required after one or more CURVEPOINT commands.
  334.  
  335. Multiple operations in the same command should be avoided, since the
  336. order in which they are applied is not defined.
  337.  
  338. Examples:
  339.         CURVE CONTRAST +10      [increase contrast]
  340.         CURVE BRIGHTNESS -10    [decrease brightness]
  341.         CURVE MONOTONIC
  342.         CURVE SMOOTH
  343.         CURVE NEGATE
  344.         CURVE INIT
  345.         CURVE UPDATE            [redisplay curves]
  346.  
  347.  
  348. CURVEPOINT      *
  349.  
  350. Format:   CURVEPOINT [IN] <inputval> [OUT] <outputval>
  351.  
  352. Template: IN/N/K,OUT/N/K
  353.  
  354. Purpose:  Sets the value of a point on the active color response
  355.           curves.
  356.  
  357. Description:
  358.  
  359. This command makes it possible to change color response curves on a
  360. point-by-point basis.  A point is specified by its input value
  361. (0-255) and an output value (0-16383).
  362.  
  363. Note the different ranges.  The input value is always an eight
  364. bit value (0 to 255), while the output value uses a wider scale with
  365. 16383 as the maximum value.  To scale an eight bit value up to this
  366. range, use:
  367.  
  368.         outval = eightbitval * 16383 / 255
  369.  
  370. Or for a quick and dirty approach:
  371.  
  372.         outval = eightbitval * 64
  373.  
  374. The point will be entered into all active curves. (Use SETCURVE
  375. to set the active curves.)
  376.  
  377. NOTE: This command does not update the visual display of the color
  378. curves after entering the point.  The CURVE UPDATE command must be
  379. used after all points have been entered.
  380.  
  381. Examples:
  382.         CURVEPOINT 0 0          [one end]
  383.         CURVEPOINT 128 8192     [the middle]
  384.         CURVEPOINT 255 16363    [and the other end]
  385.  
  386.  
  387. DISPLAY
  388.  
  389. Format:   DISPLAY
  390.  
  391. Template: ,
  392.  
  393. Purpose:  Displays the current image.
  394.  
  395. Description:
  396.  
  397. If an image is open, DISPLAY opens a screen and renders the image into
  398. it.
  399.  
  400. Example:
  401.         DISPLAY
  402.  
  403.  
  404. DITHER          *SA
  405.  
  406. Format:   DITHER [NONE | FLOYD | JARVIS | STUCKI | ORDERED | RANDOM |
  407.           SPIRAL]
  408.  
  409. Template: NONE/S,FLOYD/S,JARVIS/S,STUCKI/S,ORDERED/S,RANDOM/S,SPIRAL/S
  410.  
  411. Purpose:  Sets the type of dithering used to reduce from 24 bits to
  412.           12 bits.
  413.  
  414. Description:
  415.  
  416. This command controls the "24->12 dither" setting.
  417.  
  418. Example:
  419.         DITHER FLOYD
  420.  
  421.  
  422. DITHER2         *SA
  423.  
  424. Format:   DITHER2 [NONE | FLOYD | JARVIS | STUCKI]
  425.  
  426. Template: NONE/S,FLOYD/S,JARVIS/S,STUCKI/S
  427.  
  428. Purpose:  Sets the type of dithering used to render to the display.
  429.  
  430. Description:
  431.  
  432. This command controls the "12->display dither" setting.
  433.  
  434. Example:
  435.         DITHER2 NONE
  436.  
  437.  
  438. EXPORT
  439.  
  440. Format:   EXPORT [EXPORTER <name>] [NAME <filename>] [ARGS <args>]
  441.  
  442. Template: EXPORTER/K,NAME/K,ARGS/K
  443.  
  444. Purpose:  Processes the current image through an exporter module.
  445.  
  446. Description:
  447.  
  448. Without the NAME and ARGS arguments, the EXPORT command brings up the
  449. list of available exporters and allows one to be chosen, just as if
  450. the EXPORT button were selected by the user.
  451.  
  452. Alternatively, the exporter program and its arguments may be specified
  453. as part of the command.  This will bypass the list display and run a
  454. specific exporter directly.  The proper name and args for an exporter
  455. must be obtained first.  (See the filter/exporter reference for
  456. information on specific exporters.)
  457.  
  458. The NAME keyword allows the name of the file to be exported to be
  459. specified.  This information is passed on to the exporter program,
  460. and may be used or ignored depending on the exporter.  Typically, if
  461. you specify a file name, the exporter will not display a file
  462. requester.
  463.  
  464. Examples:
  465.         EXPORT NAME foo.out             [user selects from list]
  466.         EXPORT NAME foo.bw-eps EXPORTER "export_eps" ARGS "bw"
  467.                                         [uses a specific exporter]
  468.  
  469.  
  470. FILTERPATH      *A
  471.  
  472. Format:   FILTERPATH [NAME] <filterpath>
  473.  
  474. Template: NAME/A
  475.  
  476. Purpose:  Sets the disk path to find filters and exporters.
  477.  
  478. Description:
  479.  
  480. This command sets the directory where HAMLAB PLUS input filter and
  481. exporter modules are stored.
  482.  
  483. Example:
  484.         FILTERPATH "SYS:hl-filters"
  485.  
  486.  
  487. FIXHAM          *A
  488.  
  489. Format:   FIXHAM [ON=TRUE=YES | OFF=FALSE=NO]
  490.  
  491. Template: ON=TRUE=YES/S,OFF=FALSE=NO/S
  492.  
  493. Purpose:  Turns glitchless HAM scrolling on or off.
  494.  
  495. Description:
  496.  
  497. This command controls the "Fix Ham Scrolling" setting, which repairs
  498. left edge glitches caused when the true left edge of a HAM picture is
  499. not visible on the display.
  500.  
  501. Example:
  502.         FIXHAM ON
  503.  
  504.  
  505. GAMMA           *SA
  506.  
  507. Format:   GAMMA [VALUE] <gamma> [COMPENSATE | UNCOMPENSATE]
  508.  
  509. Template: VALUE/N,COMPENSATE/S,UNCOMPENSATE/S
  510.  
  511. Purpose:  Loads a gamma value and/or applies it to the color response
  512.           curves.
  513.  
  514. Description:
  515.  
  516. This command changes the current gamma value and/or applies it to the
  517. active color response curves.
  518.  
  519. VALUE specifies the gamma value, which must be between 0.1 and 9.9 and
  520. must be written that way (two digits separated by a period).
  521.  
  522. The COMPENSATE and UNCOMPENSATE keywords apply the gamma to the active
  523. color response curves.
  524.  
  525. Example:
  526.         GAMMA 2.2 COMPENSATE
  527.  
  528.  
  529. GETATTR
  530.  
  531. Format:   GETATTR [OBJECT] <object> STEM <stem>
  532.  
  533. Template: OBJECT/A,STEM/K
  534.  
  535. Purpose:  Returns the contents of a HAMLAB PLUS attribute in an AREXX
  536.           stem variable.
  537.  
  538. Description:
  539.  
  540. GETATTR obtains the values of a group of related HAMLAB PLUS
  541. attributes and copies their values into AREXX variables.
  542.  
  543. The OBJECT is one of several object names that HAMLAB PLUS
  544. understands.  See the end of this section for a complete list of
  545. OBJECTs and their associated attributes.
  546.  
  547. The STEM keyword specifies the base name of all of the AREXX variables
  548. to be filled in by the GETATTR command.  The base name may optionally
  549. be followed by a period.
  550.  
  551. See the HAMLAB PLUS ATTRIBUTES section for a complete list of objects
  552. supported by the getattr command and their attributes.
  553.  
  554. Example:
  555.         GETATTR APPLICATION STEM APPL.    [fills in APPL.NAME, etc.]
  556.  
  557.  
  558. INPUTCROP       *S
  559.  
  560. Format:   INPUTCROP [WIDTH <width>] [HEIGHT <height>]
  561.           [UL <x1>,<y1>] [LR <x2>,<y2>] [FULLSIZE]
  562.  
  563. Template: WIDTH/N/K,HEIGHT/N/K,UL/K,LR/K,FULLSIZE/S
  564.  
  565. Purpose:  Sets the input cropping limits.
  566.  
  567. Description:
  568.  
  569. This command changes the input cropping boundaries.  In one command,
  570. you may specify the boundaries by width and/or height, or by
  571. coordinates of the upper left and/or lower right corners.
  572.  
  573. Coordinates are specified by two numbers separated by a comma.  There
  574. should be no space between the comma and either number.
  575.  
  576. The FULLSIZE keyword resets the cropping boundaries to include the
  577. full image.
  578.  
  579. Specifying conflicting arguments in the same command should be
  580. avoided.
  581.  
  582. Examples:
  583.         INPUTCROP WIDTH 320 HEIGHT 200  [by size]
  584.         INPUTCROP UL 0,0 LR 100,100     [by corners]
  585.         INPUTCROP FULLSIZE              [reset to full size]
  586.  
  587.  
  588. LOADCONFIG      *
  589.  
  590. Format:   LOADCONFIG [FILENAME <filename>]
  591.  
  592. Template: FILENAME/K
  593.  
  594. Purpose:  Loads settings from a configuration file.
  595.  
  596. Description:
  597.  
  598. This command loads a previously saved configuration file.  If a path
  599. and file name is specified with the FILENAME keyword it will be used.
  600. Otherwise, a file requester will be displayed and the user's choice
  601. will be loaded.
  602.  
  603. Example:
  604.         LOADCONFIG FILENAME "SYS:hlconfigs/hires"
  605.  
  606.  
  607. LOADCURVES      *A
  608.  
  609. Format:   LOADCURVES [FILENAME <name>]
  610.  
  611. Template: FILENAME/K
  612.  
  613. Purpose:  Loads a set of color response curves from a HamLab curve
  614.           file or an IFF CLUT chunk.
  615.  
  616. Description:
  617.  
  618. This command causes the active color response curves to be loaded
  619. from a file.  (Either a HamLab color curve file or from the CLUT
  620. chunks of any IFF picture containing them.)  If a name is specified
  621. with the FILENAME keyword, it will be used.  Otherwise, a file
  622. requester will be displayed and the user's choice will be used.
  623.  
  624. Example:
  625.         LOADCURVES FILENAME "ram:scanner1.curve"
  626.  
  627.  
  628. LOADPALETTE     *A
  629.  
  630. Format:   LOADPALETTE [FILENAME <name>]
  631.  
  632. Template: FILENAME/K
  633.  
  634. Purpose:  Loads a fixed set of colors from an IFF palette file.
  635.  
  636. Description:
  637.  
  638. This command loads an IFF palette file, automatically switching to
  639. FROZEN palette mode if necessary.  If a name is specified with the
  640. FILENAME keyword, it will be used.  Otherwise, a file requester will
  641. be displayed and the user's choice will be used.
  642.  
  643. Example:
  644.         LOADPALETTE FILENAME "ram:frame1.pal"
  645.  
  646.  
  647. LOCKBACKGROUND  *SA
  648.  
  649. Format:   LOCKBACKGROUND [ON=TRUE=YES | OFF=FALSE=NO]
  650.  
  651. Template: ON=TRUE=YES/S,OFF=FALSE=NO/S
  652.  
  653. Purpose:  Sets whether the exact background color is preserved.
  654.  
  655. Description:
  656.  
  657. This command controls the "Lock background color" setting.
  658.  
  659. Example:
  660.         LOCKBACKGROUND FALSE
  661.  
  662.  
  663. LOCKGUI
  664.  
  665. Format:   LOCKGUI
  666.  
  667. Template: ,
  668.  
  669. Purpose:  Deactivates all program gadgets.
  670.  
  671. Description:
  672.  
  673. LOCKGUI causes the busy pointer (the watch) to be displayed in all
  674. windows.
  675.  
  676. WARNING: this command can cause the HAMLAB PLUS to appear locked up.
  677. No HL+ gadgets (except buttons like OK and Cancel in requesters) will
  678. respond to any further activity until an UNLOCKGUI command is
  679. received.
  680.  
  681. Executing LOCKGUI more than once has no effect -- the program is only
  682. locked once, and a single UNLOCKGUI command will always unlock it.
  683.  
  684. Example:
  685.         LOCKGUI
  686.  
  687.  
  688. MESSAGE         *
  689.  
  690. Format:   MESSAGE [[PROMPT] <message>] [CLEAR]
  691.  
  692. Template: PROMPT,CLEAR/S
  693.  
  694. Purpose:  Displays a message in the HAMLAB PLUS message area.
  695.  
  696. Description:
  697.  
  698. Writes a single line message to the three line message area in the
  699. HAMLAB PLUS base window, scrolling previous messages up, if any.
  700.  
  701. The CLEAR keyword clears the message area before displaying the
  702. message.
  703.  
  704. Examples:
  705.         MESSAGE "Hello, world!"
  706.         MESSAGE CLEAR
  707.         MESSAGE CLEAR "Starting complicated process..."
  708.  
  709.  
  710. MODULE          *A
  711.  
  712. Format:   MODULE OLDFILTER NAME <name> PATTERN <magic>
  713.           MODULE INPUTFILTER NAME <name> PATTERN <magic> ARGS <args>
  714.           MODULE EXPORTER NAME <name> DESCRIPTION <desc> ARGS <args>
  715.  
  716. Template: OLDFILTER/S,INPUTFILTER/S,EXPORTER/S,
  717.           NAME/A/K,MAGIC/K,DESCRIPTION/K,ARGS/K
  718.  
  719. Purpose:  Makes an input filter or exporter known to HAMLAB PLUS.
  720.  
  721. Description:
  722.  
  723. These commands, used primarily in config files, give HAMLAB PLUS
  724. information about available input filter and exporter modules.  Three
  725. types of modules are possible:
  726.  
  727.         OLDFILTER       a HamLab 1.x input filter.  Described by NAME
  728.                         of the module and a PATTERN which must be
  729.                         matched in an input file for this filter to
  730.                         be used.
  731.  
  732.         INPUTFILTER     a HamLab 2.x input filter.  Described by NAME
  733.                         of the module, PATTERN to be matched, and an
  734.                         ARGS string to be passed to the filter.
  735.  
  736.         EXPORTER        a HamLab 2.x exporter.  Described by NAME of
  737.                         the module, a text DESCRIPTION used for the
  738.                         list presented to the user, and an ARGS
  739.                         string to be passed to the exporter.
  740.  
  741. Examples:
  742.         MODULE OLDFILTER NAME "ilbm2hl" PATTERN "FORM"
  743.         MODULE INPUTFILTER NAME "ilbm_input" PATTERN "FORM" ARGS ""
  744.         MODULE EXPORTER NAME "export_iff24" DESCRIPTION "24bit IFF"
  745.                 ARGS ""
  746.  
  747.  
  748. NOP             *
  749.  
  750. Format:   NOP
  751.  
  752. Template: ,
  753.  
  754. Purpose:  Does absolutely nothing.
  755.  
  756. Description:
  757.  
  758. This command does absolutely nothing.
  759.  
  760. Example:
  761.         NOP
  762.  
  763.  
  764. ONESTEP         *SA
  765.  
  766. Format:   ONESTEP [ON=TRUE=YES | OFF=FALSE=NO]
  767.  
  768. Template: ON=TRUE=YES/S,OFF=FALSE=NO/S
  769.  
  770. Purpose:  Sets whether dithering is done in one or two steps.
  771.  
  772. Description:
  773.  
  774. This command controls the "One step dithering" setting.
  775.  
  776. Example:
  777.         ONESTEP ON
  778.  
  779.  
  780. OPEN
  781.  
  782. Format:   OPEN [FILENAME <filename>] [FORCE]
  783.  
  784. Template: FILENAME/K,FORCE/S
  785.  
  786. Purpose:  Opens a new image.
  787.  
  788. Description:
  789.  
  790. Clears the current image, if any (see CLEAR), and attempts to open a
  791. new image.  Returns a warning result code (5) if the file cannot be
  792. opened for any reason.
  793.  
  794. The FORCE keyword suppresses the confirmation requester before
  795. clearing the current image.
  796.  
  797. If a filename (including a full path) is specified with the FILENAME
  798. keyword, it will be used, otherwise, the normal file requester will
  799. be used to allow the input file name to be selected.
  800.  
  801. Examples:
  802.         OPEN FILENAME foo.bar FORCE     [no requesters]
  803.         OPEN                            [displays requester]
  804.  
  805.  
  806. OUTPUTCROP      *S
  807.  
  808. Format:   OUTPUTCROP [WIDTH <width>] [HEIGHT <height>]
  809.           [UL <x1>,<y1>] [LR <x2>,<y2>] [FULLSIZE]
  810.  
  811. Template: WIDTH/N/K,HEIGHT/N/K,UL/K,LR/K,FULLSIZE/S
  812.  
  813. Purpose:  Sets the output cropping limits.
  814.  
  815. Description:
  816.  
  817. This command changes the output cropping boundaries.  In one command,
  818. you may specify the boundaries by width and/or height, or by
  819. coordinates of the upper left and/or lower right corners.
  820.  
  821. Coordinates are specified by two numbers separated by a comma.  There
  822. should be no space between the comma and either number.
  823.  
  824. The FULLSIZE keyword resets the cropping boundaries to include the
  825. full image.
  826.  
  827. Specifying conflicting arguments in the same command should be
  828. avoided.
  829.  
  830. Examples:
  831.         OUTPUTCROP WIDTH 320 HEIGHT 200 [by size]
  832.         OUTPUTCROP UL 0,0 LR 100,100    [by corners]
  833.         OUTPUTCROP FULLSIZE             [reset to full size]
  834.  
  835.  
  836. PALETTEMODE     *SA
  837.  
  838. Format:   PALETTEMODE [NORMAL | SLICED <num> | FROZEN]
  839.  
  840. Template: NORMAL/S,SLICED/K/N,FROZEN/S
  841.  
  842. Purpose:  Sets the type of palette used for the output.
  843.  
  844. Description:
  845.  
  846. This command sets the type of palette used for displaying and saving.
  847. The NORMAL and FROZEN keywords select their respective modes.  The
  848. SLICED keyword selects sliced mode, and must be followed by a number
  849. indicating the number of colors to slice.
  850.  
  851. Examples:
  852.         PALETTEMODE NORMAL              [normal palette]
  853.         PALETTEMODE SLICED 7            [sliced mode, 7 colors sliced]
  854.  
  855.  
  856. PAN
  857.  
  858. Format:   PAN [X <num>] [Y <num>] [ABSOLUTE]
  859.  
  860. Template: X/N,Y/N,ABSOLUTE/S
  861.  
  862. Purpose:  Scrolls the display to expose a different portion of the
  863. current image.
  864.  
  865. Description:
  866.  
  867. PAN determines what coordinates of the image are positioned in the
  868. upper left corner of the screen.  Normally the upper left corner
  869. displays the upper left corner of the image (0, 0).  Normally the
  870. coordinates are changed incrementally, but the ABSOLUTE keyword will
  871. cause the coordinates to be replaced, rather than added to.  Either
  872. the X coordinate, the Y coordinate, or both may be changed.
  873.  
  874. All panning movements are restricted to keep part of the image on
  875. screen.  Thus PAN ABSOLUTE X 9999 will move to the right edge of anyo
  876. reasonably sized image.
  877.  
  878. Examples:
  879.         PAN X +10                       [relative scroll right]
  880.         PAN Y -10                       [relative scroll up]
  881.         PAN ABSOLUTE X 0 Y 0            [reset to upper left]
  882.  
  883.  
  884. PIPEDEV         *A
  885.  
  886. Format:   PIPEDEV [NAME] <pipedevice>
  887.  
  888. Template: NAME/A
  889.  
  890. Purpose:  Sets the device to use for pipes.
  891.  
  892. Description:
  893.  
  894. This command sets the device to be used whenever HAMLAB PLUS uses a
  895. DOS pipe.  Currently HAMLAB PLUS only uses DOS pipes to interface to
  896. old HamLab 1.x input filters.
  897.  
  898. Example:
  899.         PIPEDEV "PIPE:"
  900.  
  901.  
  902. QUIT
  903.  
  904. Format:   QUIT [FORCE]
  905.  
  906. Template: FORCE/S
  907.  
  908. Purpose:  Exits HAMLAB PLUS.
  909.  
  910. Description:
  911.  
  912. The FORCE keyword suppresses the requester that would be displayed
  913. before quitting with an unsaved image loaded.
  914.  
  915. Examples:
  916.         QUIT                            [may display requester]
  917.         QUIT FORCE                      [never a requester]
  918.  
  919.  
  920. REQUESTFILE
  921.  
  922. Format:   REQUESTFILE [TITLE <title>] [PATH <path>] [FILE <file>]
  923.           [PATTERN <pattern>]
  924.  
  925. Template: TITLE/K,PATH/K,FILE/K,PATTERN/K
  926.  
  927. Purpose:  Gets input from a file requester.
  928.  
  929. Description:
  930.  
  931. This command displays a generic file requester.  If the user selects a
  932. file name, the special variable RESULT will be filled in with the full
  933. path name.  Otherwise, a warning result code will be returned.
  934.  
  935. The TITLE keyword specifies a window title.  The PATH, FILE, and
  936. PATTERN keywords specify initial values for the file requester.  If
  937. any of these are omitted, empty strings will be used as the default.
  938.  
  939. Example:
  940.         REQUESTFILE TITLE "Select a file" PATH "ram:" PATTERN "#?.iff"
  941.                                         [returns full path in RESULT]
  942.  
  943.  
  944. REQUESTNOTIFY
  945.  
  946. Format:   REQUESTNOTIFY [TITLE <title>] [PROMPT <prompt>]
  947.  
  948. Template: TITLE/K,PROMPT/K
  949.  
  950. Purpose:  Displays an information-only requester.
  951.  
  952. Description:
  953.  
  954. This command displays a simple requester with a title, one line of
  955. text, and an OK button.
  956.  
  957. The TITLE keyword specifies text for the requester's title bar.  The
  958. PROMPT keyword specifies text displayed within the requester.
  959.  
  960. Example:
  961.         REQUESTNOTIFY TITLE "Notice" PROMPT "Rendering all done!"
  962.                                         [no return value]
  963.  
  964.  
  965. REQUESTNUMBER
  966.  
  967. Format:   REQUESTNUMBER [PROMPT <prompt>] [DEFAULT <number>]
  968.  
  969. Template: PROMPT/K,DEFAULT/N/K
  970.  
  971. Purpose:  Gets input from a number entry requester.
  972.  
  973. Description:
  974.  
  975. This command displays a generic number entry requester.  If the user
  976. enters a number, it will be returned in the special RESULT varaible.
  977. Otherwise, a warning result will be returned.
  978.  
  979. The PROMPT keyword specifies prompting text to be used in the
  980. requester's title bar.  The DEFAULT keyword specifies the initial
  981. value for the number entry gadget.
  982.  
  983. Example:
  984.         REQUESTNUMBER PROMPT "Enter width:" DEFAULT 640
  985.                                         [returns number in RESULT]
  986.  
  987.  
  988. REQUESTRESPONSE
  989.  
  990. Format:   REQUESTRESPONSE [TITLE <title>] [PROMPT <prompt>]
  991.  
  992. Template: TITLE/K,PROMPT/K
  993.  
  994. Purpose:  Gets a yes/no response from a requester.
  995.  
  996. Description:
  997.  
  998. This command displays a generic yes/no requester (actually, it's an
  999. OK/Cancel requester.) If the user selects OK, a normal zero result
  1000. code is returned, otherwise a warning code (5) is returned.
  1001.  
  1002. The TITLE keyword specifies text for the requester's title bar.  The
  1003. PROMPT keyword specifies text displayed within the requester.
  1004.  
  1005. Example:
  1006.         REQUESTRESPONSE TITLE "Confirmation" PROMPT "Ok to exit?"
  1007.                                         [returns RC=0 (ok) or RC=5]
  1008.  
  1009.  
  1010. REQUESTSTRING
  1011.  
  1012. Format:   REQUESTSTRING [PROMPT <prompt>] [DEFAULT <string>]
  1013.  
  1014. Template: PROMPT/K,DEFAULT/K
  1015.  
  1016. Purpose:  Gets input from a string entry requester.
  1017.  
  1018. Description:
  1019.  
  1020. This command displays a generic string entry requester.  If the user
  1021. enters a string, it will be returned in the special RESULT variable.
  1022. Otherwise, a warning result code will be returned.
  1023.  
  1024. The PROMPT keyword specifies prompting text to be used in the
  1025. requester's title bar.  The DEFAULT keyword specifies the initial
  1026. value for the string entry gadget.
  1027.  
  1028. Example:
  1029.         REQUESTSTRING PROMPT "Enter your name:" DEFAULT "Ed"
  1030.                                         [returns string in RESULT]
  1031.  
  1032.  
  1033. RESOLUTION      *SA
  1034.  
  1035. Format:   RESOLUTION [LOW | HIGH] [LACE | NOLACE]
  1036.  
  1037. Template: LOW/S,HIGH/S,LACE/S,NOLACE/S
  1038.  
  1039. Purpose:  Sets the output resolution.
  1040.  
  1041. Description:
  1042.  
  1043. This command sets the display resolution and/or interlace setting.
  1044.  
  1045. Examples:
  1046.         RESOLUTION LOW
  1047.         RESOLUTION HIGH LACE
  1048.  
  1049.  
  1050. REVERT
  1051.  
  1052. Format:   REVERT
  1053.  
  1054. Template: ,
  1055.  
  1056. Purpose:  Revert to previous settings.
  1057.  
  1058. Description:
  1059.  
  1060. This command returns all settings to those used for the last DISPLAY
  1061. or SAVE operation.
  1062.  
  1063. Example:
  1064.         REVERT
  1065.  
  1066.  
  1067. REXXCONSOLE     *A
  1068.  
  1069. Format:   REXXCONSOLE [NAME] <window>
  1070.  
  1071. Template: NAME/A
  1072.  
  1073. Purpose:  Sets the window description to use for the REXX console
  1074.           window.
  1075.  
  1076. Description:
  1077.  
  1078. This command sets the DOS console window description to be used for
  1079. the AREXX console window.  See the AmigaDOS manual for the format
  1080. for console window descriptions.
  1081.  
  1082. If the AREXX console is already open, the changes will not be
  1083. reflected until the console window is closed and reopened.
  1084.  
  1085. Example:
  1086.         REXXCONSOLE "CON:0/0/500/100/REXX Console/CLOSE"
  1087.  
  1088.  
  1089. SAVE
  1090.  
  1091. Format:   SAVE [OVERWRITE]
  1092.  
  1093. Template: OVERWRITE/S
  1094.  
  1095. Purpose:  Saves the current image using the current path and filename.
  1096.  
  1097. Description:
  1098.  
  1099. The OVERWRITE keyword suppresses the confirmation requester that would
  1100. be displayed before overwriting an existing file.
  1101.  
  1102. Examples:
  1103.         SAVE                            [asks before overwriting]
  1104.         SAVE OVERWRITE                  [doesn't ask]
  1105.  
  1106.  
  1107. SAVEAS
  1108.  
  1109. Format:   SAVEAS [NAME <filename>] [OVERWRITE]
  1110.  
  1111. Template: NAME/K,OVERWRITE/S
  1112.  
  1113. Purpose:  Saves the current image using a new filename.
  1114.  
  1115. Description:
  1116.  
  1117. If a filename (including a full path) is specified with the NAME
  1118. keyword, it will be used.  Otherwise, the normal save file requester
  1119. will be used to allow the user to enter the filename.
  1120.  
  1121. The OVERWRITE keyword suppresses the confirmation requester that would
  1122. be displayed before overwriting an existing file.
  1123.  
  1124. Example:
  1125.         SAVEAS NAME dh0:foo.iff OVERWRITE
  1126.  
  1127.  
  1128. SAVECONFIG
  1129.  
  1130. Format:   SAVECONFIG [NAME <filename>] [ALL]
  1131.  
  1132. Template: NAME/K,ALL/S
  1133.  
  1134. Purpose:  Saves current settings to a configuration file.
  1135.  
  1136. Description:
  1137.  
  1138. If a filename is specified with the NAME keyword, it will be used.
  1139. Otherwise, a file requester will be displayed and the user's choice
  1140. will be used.
  1141.  
  1142. If the ALL keyword is specified, a full set of commands will be saved
  1143. in the config file, just as if the "Save All" button were selected.
  1144. Otherwise, a partial config file will be saved.  Note the S and A
  1145. indicated with commands in this section tell which commands are
  1146. included in partial and full config files.
  1147.  
  1148. Cropping settings will only be saved in a partial config file, and
  1149. only when an image is currently open.
  1150.  
  1151. Examples:
  1152.         SAVECONFIG ALL                          [full config file]
  1153.         SAVECONFIG NAME "hlconfigs:hires"       [partial config file]
  1154.  
  1155.  
  1156. SAVECURVES
  1157.  
  1158. Format:   SAVECURVES [NAME <filename>] [OVERWRITE]
  1159.  
  1160. Template: NAME/K,OVERWRITE/S
  1161.  
  1162. Purpose:  Saves current color response curves to a HamLab curve file.
  1163.  
  1164. Description:
  1165.  
  1166. If a filename is specified with the NAME keyword, it will be used.
  1167. Otherwise, a file requester will be displayed and the user's choice
  1168. will be used.
  1169.  
  1170. If the OVERWRITE keyword is specified, the requester that would
  1171. normally be displayed before overwriting an existing file will be
  1172. suppressed.
  1173.  
  1174. Example:
  1175.         SAVECURVES NAME "hlcurves:scanner-compensation"
  1176.  
  1177.  
  1178. SAVEMODE        *SA
  1179.  
  1180. Format:   SAVEMODE [PCHG] [SHAM] [DYNAMIC]
  1181.  
  1182. Template: PCHG/S,SHAM/S,DYNAMIC/S
  1183.  
  1184. Purpose:  Sets the type(s) of special IFF chunks used to save "sliced"
  1185.           output files.
  1186.  
  1187. Description:
  1188.  
  1189. This command determines which combination of three IFF formats will be
  1190. used to store sliced color information.  At least one, and as many as
  1191. all three, of the PCHG SHAM and DYNAMIC keywords must be specified.
  1192.  
  1193. Examples:
  1194.         SAVEMODE PCHG           [save PCHG chunks only]
  1195.         SAVEMODE SHAM DYNAMIC   [save both SHAM and DYNAMIC chunks]
  1196.  
  1197.  
  1198. SAVEPALETTE
  1199.  
  1200. Format:   SAVEPALETTE [NAME <filename>] [OVERWRITE]
  1201.  
  1202. Template: NAME/K,OVERWRITE/S
  1203.  
  1204. Purpose:  Saves current palette colors to an IFF palette file.
  1205.  
  1206. Description:
  1207.  
  1208. If a filename is specified with the NAME keyword, it will be used.
  1209. Otherwise, a file requester will be displayed and the user's choice
  1210. will be used.
  1211.  
  1212. If the OVERWRITE keyword is specified, the requester that would
  1213. normally be displayed before overwriting an existing file will be
  1214. suppressed.
  1215.  
  1216. This command is only valid when the palette is in FROZEN mode.  Using
  1217. it in other situations will return an error.
  1218.  
  1219. Example:
  1220.         SAVEPALETTE NAME "ram:frame1.pal" OVERWRITE
  1221.  
  1222.  
  1223. SCALE           *SA
  1224.  
  1225. Format:   SCALE [X <xscale>] [Y <yscale>] [PERCENT]
  1226.           [CONSTRAINED|UNCONSTRAINED]
  1227.  
  1228. Template: X/N/K,Y/N/K,PERCENT/S,CONSTRAINED/S,UNCONSTRAINED/S
  1229.  
  1230. Purpose:  Sets the scaling factor(s).
  1231.  
  1232. Description:
  1233.  
  1234. This command changes the X and Y scaling factors used by HAMLAB PLUS.
  1235. The default is to specify the scaling by the size of the resulting
  1236. image, but the PERCENT keyword will cause the values to be interpreted
  1237. as percentages.
  1238.  
  1239. Note that the PERCENT keyword will apply to both X and Y if both are
  1240. used in the same command.
  1241.  
  1242. The CONSTRAINED/UNCONSTRAINED keyword changes the state of the
  1243. "Constrained Scale" setting.  (When turned on, changes in one
  1244. dimension will cause proportional changes in the other dimension,
  1245. preserving the aspect ratio.)
  1246.  
  1247. Examples:
  1248.         SCALE X 320 Y 400       [result will be 320x400 pixels]
  1249.         SCALE X 100 PERCENT     [will be 100% of original width]
  1250.         SCALE CONSTRAINED       [turns constrained scaling on]
  1251.  
  1252.  
  1253. SETCURVE        *SA
  1254.  
  1255. Format:   SETCURVE [RED] [GREEN] [BLUE] [[STEPSIZE] <stepsize>]
  1256.  
  1257. Template: RED/S,GREEN/S,BLUE/S,STEPSIZE/N
  1258.  
  1259. Purpose:  Sets the active curves and/or the curve operation step size.
  1260.  
  1261. Description:
  1262.  
  1263. This command sets which color response curves are "active," (affected
  1264. by other curve modification commands) and sets the step size used by
  1265. other curve modification commands.
  1266.  
  1267. A curve is made active by including its keyword (RED or GREEN or
  1268. BLUE).  Omitting a keyword for a curve will deactivate it.
  1269.  
  1270. The optional STEPSIZE keyword takes a single numeric argument of 1, 2,
  1271. 4, or 8.
  1272.  
  1273. Example:
  1274.         SETCURVE RED GREEN BLUE STEPSIZE 2
  1275.  
  1276.  
  1277. SETREQ          *A
  1278.  
  1279. Format:   SETREQ INPUT|OUTPUT|CURVE|PALETTE [PATH <path>]
  1280.           [FILE <file>] [PATTERN <pattern>]
  1281.  
  1282. Template: INPUT/S,OUTPUT/S,CURVE/S,PALETTE/S,PATH/K,FILE/K,PATTERN/K
  1283.  
  1284. Purpose:  Sets the initial values for a file requester.
  1285.  
  1286. Description:
  1287.  
  1288. This command allows the fields of HAMLAB PLUS file requesters to be
  1289. configured to useful initial values.  There are four controllable
  1290. sets of file requester values, corresponding to various operations
  1291. as follows:
  1292.  
  1293.         INPUT   loading images
  1294.         OUTPUT  saving and exporting
  1295.         CURVE   loading and saving curves
  1296.         PALETTE loading and saving palettes
  1297.  
  1298. For each set, three values may be set:
  1299.  
  1300.         PATH    the initial directory name
  1301.         FILE    the initial file name
  1302.         PATTERN the wild-card matching pattern
  1303.                 (blank pattern matches everything)
  1304.  
  1305. The PATTERN field is only supported by the Release 2 ASL file
  1306. requester.
  1307.  
  1308. For the OUTPUT requester, the FILE value is used to set the
  1309. extension (i.e. ".iff" ".ham" etc.) of the filename.  The rest of
  1310. the name is derived from the original name.
  1311.  
  1312. Once a user changes a value in a file requester, the changed value
  1313. will replace the previous value for the next time the file requester
  1314. is used.
  1315.  
  1316. Examples:
  1317.         SETREQ INPUT PATH "DH0:stuff" FILE "" PATTERN "#?.(gif|jpg)"
  1318.         SETREQ OUTPUT PATH "DH1:mypics" FILE ".iff" PATTERN "#?.iff"
  1319.  
  1320.  
  1321. TEMPPATH        *A
  1322.  
  1323. Format:   TEMPPATH [NAME] <temppath>
  1324.  
  1325. Template: NAME/A
  1326.  
  1327. Purpose:  Sets the disk path for temporary files.
  1328.  
  1329. Description:
  1330.  
  1331. This command sets the directory where temporary 12- and 24-bit disk
  1332. cache files are created.
  1333.  
  1334. If temporary files already exist in the old temporary directory, they
  1335. will remain until other operations require them to be deleted and/or
  1336. recreated.
  1337.  
  1338. Example:
  1339.         TEMPPATH "T:"
  1340.  
  1341.  
  1342. UNLOCKGUI
  1343.  
  1344. Format:   UNLOCKGUI
  1345.  
  1346. Template: ,
  1347.  
  1348. Purpose:  Reactivates all program gadgets.
  1349.  
  1350. Description:
  1351.  
  1352. Unlocks the user interface, which was previously locked by LOCKGUI.
  1353.  
  1354. UNLOCKGUI can only unlock a lock created by the LOCKGUI command.
  1355. Other locked conditions, such as during long processes, can only be
  1356. unlocked by selecting the appropriate cancel gadget.
  1357.  
  1358. Executing UNLOCKGUI when the program is not locked has no effect.
  1359.  
  1360. Example:
  1361.         UNLOCKGUI
  1362.  
  1363.  
  1364. WINDOW          *A
  1365.  
  1366. Format:   WINDOW [NAME] [ABOUT|BASE|OUTPUT|CONFIG|COLOR] [[LEFT] <leftedge>]
  1367.           [[TOP] <topedge>] [OPEN | CLOSE]
  1368.  
  1369. Template: NAME/A,LEFT/N,TOP/N,OPEN/S,CLOSE/S
  1370.  
  1371. Purpose:  Manipulates a HAMLAB PLUS window.
  1372.  
  1373. Description:
  1374.  
  1375. This command provides control over the five HAMLAB PLUS windows.  The
  1376. position of the upper left corner of the window may be specified with
  1377. the LEFT and TOP keywords, and/or the window may be opened or closed
  1378. with the appropriate keyword.
  1379.  
  1380. HAMLAB PLUS windows retain their positions, even while closed, so it
  1381. is possible to position a window even while it is closed -- the new
  1382. position will be used whenever the window is next opened.
  1383.  
  1384. If the position would cause the window to extend off the edge of the
  1385. screen, it will be adjusted to bring the window back onto the screen.
  1386.  
  1387. The BASE window cannot be closed using this command.  (It can only be
  1388. closed when exiting the program.)
  1389.  
  1390. If the OPEN command is used on a window that is already open, it will
  1391. be moved to the front.
  1392.  
  1393. Examples:
  1394.         WINDOW CONFIG LEFT 100 TOP 10   [position window]
  1395.         WINDOW COLOR OPEN               [open window]
  1396.  
  1397.  
  1398.  
  1399. HAMLAB PLUS ATTRIBUTES
  1400.  
  1401. The following are valid objects for the GETATTR ARexx function:
  1402.  
  1403. APPLICATION
  1404.  
  1405. .NAME                   string  Name of program, i.e. "HAMLAB PLUS"
  1406. .VERSION                string  Version of the program
  1407. .SCREEN                 string  Name of public screen in use, if any.
  1408.  
  1409. INPUT
  1410.  
  1411. .NAME                   string
  1412. .PATH                   string
  1413. .PATTERN                string
  1414. .WIDTH                  number (zero if no picture loaded)
  1415. .HEIGHT                 number (zero if no picture loaded)
  1416. .DEPTH                  number (zero if unknown)
  1417. .FORMAT                 string
  1418. .CROP.ULX               number
  1419. .CROP.ULY               number
  1420. .CROP.WIDTH             number
  1421. .CROP.HEIGHT            number
  1422.  
  1423. OUTPUT
  1424.  
  1425. .NAME                   string
  1426. .PATH                   string
  1427. .PATTERN                string
  1428. .EXTENSION              string
  1429. .CROP.ULX               number
  1430. .CROP.ULY               number
  1431. .WIDTH                  number
  1432. .HEIGHT                 number
  1433. .MODE.RESOLUTION        HIGH/LOW
  1434. .MODE.INTERLACE         ON/OFF
  1435. .MODE.ONESTEP           ON/OFF
  1436. .MODE.LOCKBACKGROUND    ON/OFF
  1437. .MODE.BITPLANES         1-5/HAM/HALFBRITE
  1438. .MODE.DITHER            NONE/FLOYD/JARVIS/STUCKI/ORDERED/RANDOM/SPIRAL
  1439. .MODE.DITHER2           NONE/FLOYD/JARVIS/STUCKI
  1440. .MODE.PALETTEMODE       NORMAL/SLICED/FROZEN
  1441. .MODE.SLICECOLORS       number
  1442. .MODE.SAVEMODE          PCHG SHAM DYNAMIC
  1443.  
  1444. SCALE
  1445.  
  1446. .X                      number
  1447. .Y                      number
  1448. .XPERCENT               ON/OFF
  1449. .YPERCENT               ON/OFF
  1450. .CONSTRAINED            ON/OFF
  1451.  
  1452. DISPLAY
  1453.  
  1454. .TOTAL.WIDTH            number
  1455. .TOTAL.HEIGHT           number
  1456. .VISIBLE.ULX            number
  1457. .VISIBLE.ULY            number
  1458. .VISIBLE.WIDTH          number
  1459. .VISIBLE.HEIGHT         number
  1460.  
  1461. COLOR
  1462.  
  1463. .GAMMA                  n.n
  1464. .STEPSIZE               1/2/4/8
  1465. .PATH                   string
  1466. .FILE                   string
  1467. .PATTERN                string
  1468. .RED                    256 packed 2-byte values
  1469. .GREEN                  256 packed 2-byte values
  1470. .BLUE                   256 packed 2-byte values
  1471.  
  1472. CONFIG
  1473.  
  1474. .FIXHAM                 ON/OFF
  1475. .BEEP                   ON/OFF
  1476. .ASK                    ON/OFF
  1477. .TEMPPATH               ON/OFF
  1478. .FILTERPATH             ON/OFF
  1479. .PIPEDEV                ON/OFF
  1480. .REXXCON                ON/OFF
  1481. .CACHE12BIT.MEM         number
  1482. .CACHE12BIT.DISK        number
  1483. .CACHE24BIT.MEM         number
  1484. .CACHE24BIT.DISK        number
  1485.  
  1486.